/*
 * Copyright (c) 2004-2005, National ICT Australia (NICTA)
 */
/*
 * Copyright (c) 2007 Open Kernel Labs, Inc. (Copyright Holder).
 * All rights reserved.
 *
 * 1. Redistribution and use of OKL4 (Software) in source and binary
 * forms, with or without modification, are permitted provided that the
 * following conditions are met:
 *
 *     (a) Redistributions of source code must retain this clause 1
 *         (including paragraphs (a), (b) and (c)), clause 2 and clause 3
 *         (Licence Terms) and the above copyright notice.
 *
 *     (b) Redistributions in binary form must reproduce the above
 *         copyright notice and the Licence Terms in the documentation and/or
 *         other materials provided with the distribution.
 *
 *     (c) Redistributions in any form must be accompanied by information on
 *         how to obtain complete source code for:
 *        (i) the Software; and
 *        (ii) all accompanying software that uses (or is intended to
 *        use) the Software whether directly or indirectly.  Such source
 *        code must:
 *        (iii) either be included in the distribution or be available
 *        for no more than the cost of distribution plus a nominal fee;
 *        and
 *        (iv) be licensed by each relevant holder of copyright under
 *        either the Licence Terms (with an appropriate copyright notice)
 *        or the terms of a licence which is approved by the Open Source
 *        Initative.  For an executable file, "complete source code"
 *        means the source code for all modules it contains and includes
 *        associated build and other files reasonably required to produce
 *        the executable.
 *
 * 2. THIS SOFTWARE IS PROVIDED ``AS IS'' AND, TO THE EXTENT PERMITTED BY
 * LAW, ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED.  WHERE ANY WARRANTY IS
 * IMPLIED AND IS PREVENTED BY LAW FROM BEING DISCLAIMED THEN TO THE
 * EXTENT PERMISSIBLE BY LAW: (A) THE WARRANTY IS READ DOWN IN FAVOUR OF
 * THE COPYRIGHT HOLDER (AND, IN THE CASE OF A PARTICIPANT, THAT
 * PARTICIPANT) AND (B) ANY LIMITATIONS PERMITTED BY LAW (INCLUDING AS TO
 * THE EXTENT OF THE WARRANTY AND THE REMEDIES AVAILABLE IN THE EVENT OF
 * BREACH) ARE DEEMED PART OF THIS LICENCE IN A FORM MOST FAVOURABLE TO
 * THE COPYRIGHT HOLDER (AND, IN THE CASE OF A PARTICIPANT, THAT
 * PARTICIPANT). IN THE LICENCE TERMS, "PARTICIPANT" INCLUDES EVERY
 * PERSON WHO HAS CONTRIBUTED TO THE SOFTWARE OR WHO HAS BEEN INVOLVED IN
 * THE DISTRIBUTION OR DISSEMINATION OF THE SOFTWARE.
 *
 * 3. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ANY OTHER PARTICIPANT BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
/*
 * Description:
 */


#ifndef __GLUE__V4_ARM__RESOURCE_FUNCTIONS_H__
#define __GLUE__V4_ARM__RESOURCE_FUNCTIONS_H__

#include <kernel/arch/resources.h>
#include <kernel/tcb.h>

/**
 * Mark the thread as being in a kernel IPC
 *
 * @param tcb                   current TCB
 */
INLINE void thread_resources_t::set_kernel_ipc (tcb_t * tcb)
{
    tcb->resource_bits += KIPC;
}


/**
 * Clear the kernel IPC bit
 *
 * @param tcb                   current TCB
 */
INLINE void thread_resources_t::clear_kernel_ipc (tcb_t * tcb)
{
    tcb->resource_bits -= KIPC;
}


/**
 * Clear the exception fastpath bit
 *
 * @param tcb                   current TCB
 */
INLINE void thread_resources_t::clear_except_fp(tcb_t * tcb)
{
    tcb->resource_bits -= EXCEPTIONFP;
}


INLINE void thread_resources_t::save(tcb_t * tcb)
{
#if defined(CONFIG_ARM_VFP)
    if (EXPECT_FALSE(tcb->resource_bits.have_resource(VFP)))
    {
        arm_vfp_save(tcb);
    }
#endif
}

INLINE void thread_resources_t::load(tcb_t * tcb)
{
#if defined(CONFIG_ARM_VFP)
    if (EXPECT_FALSE(tcb->resource_bits.have_resource(VFP)))
    {
        arm_vfp_load(tcb);
    }
#endif
}

INLINE bool thread_resources_t::control(tcb_t * tcb, tc_resources_t resources)
{
#if defined(CONFIG_ARM_VFP)
    if (!arm_vfp_control(tcb, resources.bits.arch & ARM_VFP))
        return false;
#endif
    return true;
}

INLINE void thread_resources_t::dump(tcb_t * tcb)
{
#if defined(CONFIG_ARM_VFP)
    printf("%c", tcb->resource_bits.have_resource(VFP) ? 'V' : 'v');
#endif
    printf("%c%c", tcb->resource_bits.have_resource(EXCEPTIONFP) ? 'E' : 'e',
                    tcb->resource_bits.have_resource(KIPC) ? 'K' : 'k');
}

#endif /* __GLUE__V4_ARM__RESOURCE_FUNCTIONS_H__ */
